Overview
Get Party
GET (/internal/v1/parties/{partyId})
Parameters
- partyId (path) (required)
Responses
200 OK
400 Bad Request
Bad request response
404 Not Found
Not found error response
500 Internal Server Error
Internal server error response
Architecture
id string
name string
type string
selfIndividual boolean
Indicates if the party is the user's self individual party
originParties array [object]
Item Details:
qualifiedId string <uri>
requireddomain string
requiredAllowed values:
PARTIES ACCOUNTSNo properties match your search
Try a different search term or clear the search to see all properties
Bad request response
code string
Allowed values:
urn:plmr:authentication:auth-orchestrator-api:INTERNAL_SERVER_ERROR urn:plmr:authentication:auth-orchestrator-api:BAD_REQUEST urn:plmr:authentication:auth-orchestrator-api:RESOURCE_UNKNOWN urn:plmr:authentication:auth-orchestrator-api:UNAUTHORIZED urn:plmr:authentication:auth-orchestrator-api:FORBIDDEN urn:plmr:authentication:auth-orchestrator-api:INVALID_PARAM urn:plmr:authentication:auth-orchestrator-api:WEB_APPLICATION urn:plmr:authentication:auth-orchestrator-api:PARTY_NOT_FOUND urn:plmr:authentication:auth-orchestrator-api:MISSING_QUERY_PARAMS urn:plmr:authentication:auth-orchestrator-api:USER_DOES_NOT_EXIST urn:plmr:authentication:auth-orchestrator-api:DOMAIN_ORIGIN_PARTY_ALREADY_EXISTSmessage string
requestId string
fieldErrors array [object]
Item Details:
code string
Allowed values:
urn:plmr:authentication:auth-orchestrator-api:NOT_BLANK urn:plmr:authentication:auth-orchestrator-api:NOT_NULL urn:plmr:authentication:auth-orchestrator-api:PATTERNmessage string
field string
No properties match your search
Try a different search term or clear the search to see all properties
Not found error response
code string
Allowed values:
urn:plmr:authentication:auth-orchestrator-api:INTERNAL_SERVER_ERROR urn:plmr:authentication:auth-orchestrator-api:BAD_REQUEST urn:plmr:authentication:auth-orchestrator-api:RESOURCE_UNKNOWN urn:plmr:authentication:auth-orchestrator-api:UNAUTHORIZED urn:plmr:authentication:auth-orchestrator-api:FORBIDDEN urn:plmr:authentication:auth-orchestrator-api:INVALID_PARAM urn:plmr:authentication:auth-orchestrator-api:WEB_APPLICATION urn:plmr:authentication:auth-orchestrator-api:PARTY_NOT_FOUND urn:plmr:authentication:auth-orchestrator-api:MISSING_QUERY_PARAMS urn:plmr:authentication:auth-orchestrator-api:USER_DOES_NOT_EXIST urn:plmr:authentication:auth-orchestrator-api:DOMAIN_ORIGIN_PARTY_ALREADY_EXISTSmessage string
requestId string
No properties match your search
Try a different search term or clear the search to see all properties
Internal server error response
code string
Allowed values:
urn:plmr:authentication:auth-orchestrator-api:INTERNAL_SERVER_ERROR urn:plmr:authentication:auth-orchestrator-api:BAD_REQUEST urn:plmr:authentication:auth-orchestrator-api:RESOURCE_UNKNOWN urn:plmr:authentication:auth-orchestrator-api:UNAUTHORIZED urn:plmr:authentication:auth-orchestrator-api:FORBIDDEN urn:plmr:authentication:auth-orchestrator-api:INVALID_PARAM urn:plmr:authentication:auth-orchestrator-api:WEB_APPLICATION urn:plmr:authentication:auth-orchestrator-api:PARTY_NOT_FOUND urn:plmr:authentication:auth-orchestrator-api:MISSING_QUERY_PARAMS urn:plmr:authentication:auth-orchestrator-api:USER_DOES_NOT_EXIST urn:plmr:authentication:auth-orchestrator-api:DOMAIN_ORIGIN_PARTY_ALREADY_EXISTSmessage string
requestId string
fieldErrors array [object]
Item Details:
code string
Allowed values:
urn:plmr:authentication:auth-orchestrator-api:NOT_BLANK urn:plmr:authentication:auth-orchestrator-api:NOT_NULL urn:plmr:authentication:auth-orchestrator-api:PATTERNmessage string
field string
No properties match your search
Try a different search term or clear the search to see all properties